<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Module: Spec::Runner</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Module</strong></td>
          <td class="class-name-in-header">Spec::Runner</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/backtrace_tweaker_rb.html">
                vendor\plugins\rspec/lib/spec/runner/backtrace_tweaker.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/behaviour_runner_rb.html">
                vendor\plugins\rspec/lib/spec/runner/behaviour_runner.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/command_line_rb.html">
                vendor\plugins\rspec/lib/spec/runner/command_line.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/drb_command_line_rb.html">
                vendor\plugins\rspec/lib/spec/runner/drb_command_line.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/base_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/base_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/base_text_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/base_text_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/failing_behaviours_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/failing_behaviours_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/failing_examples_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/failing_examples_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/html_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/html_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/progress_bar_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/progress_bar_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/rdoc_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/rdoc_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/snippet_extractor_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/snippet_extractor.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/formatter/specdoc_formatter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/formatter/specdoc_formatter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/heckle_runner_rb.html">
                vendor\plugins\rspec/lib/spec/runner/heckle_runner.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/heckle_runner_unsupported_rb.html">
                vendor\plugins\rspec/lib/spec/runner/heckle_runner_unsupported.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/options_rb.html">
                vendor\plugins\rspec/lib/spec/runner/options.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/option_parser_rb.html">
                vendor\plugins\rspec/lib/spec/runner/option_parser.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/reporter_rb.html">
                vendor\plugins\rspec/lib/spec/runner/reporter.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner/spec_parser_rb.html">
                vendor\plugins\rspec/lib/spec/runner/spec_parser.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/lib/spec/runner_rb.html">
                vendor\plugins\rspec/lib/spec/runner.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/behaviour_runner_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/behaviour_runner_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/drb_command_line_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/drb_command_line_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/failing_behaviours_formatter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/failing_behaviours_formatter_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/failing_examples_formatter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/failing_examples_formatter_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_dry_run_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_dry_run_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_failure_dump_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_failure_dump_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/progress_bar_formatter_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/rdoc_formatter_dry_run_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/rdoc_formatter_dry_run_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/rdoc_formatter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/rdoc_formatter_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/specdoc_formatter_dry_run_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/specdoc_formatter_dry_run_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/formatter/specdoc_formatter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/formatter/specdoc_formatter_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/noisy_backtrace_tweaker_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/noisy_backtrace_tweaker_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/object_ext_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/object_ext_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/options_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/options_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/quiet_backtrace_tweaker_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/quiet_backtrace_tweaker_spec.rb
                </a>
        <br />
                <a href="../../files/vendor\plugins\rspec/spec/spec/runner/reporter_spec_rb.html">
                vendor\plugins\rspec/spec/spec/runner/reporter_spec.rb
                </a>
        <br />
            </td>
        </tr>

        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <h2>Behaviours and Examples</h2>
<p>
Rather than expressing examples in classes, RSpec uses a custom domain
specific language to describe Behaviours and Examples of those behaviours.
</p>
<p>
A Behaviour is the equivalent of a fixture in xUnit-speak. It is a metaphor
for the context in which you will run your executable example - a set of
known objects in a known starting state. We begin be describing
</p>
<pre>
  describe Account do

    before do
      @account = Account.new
    end

    it &quot;should have a balance of $0&quot; do
      @account.balance.should == Money.new(0, :dollars)
    end

  end
</pre>
<p>
We use the before block to set up the Behaviour (given), and then the it
method to hold the example code that expresses the event (when) and the
expected outcome (then).
</p>
<h2>Helper Methods</h2>
<p>
A primary goal of RSpec is to keep the examples clear. We therefore prefer
less indirection than you might see in xUnit examples and in well factored,
DRY production code. We feel that duplication is OK if removing it makes it
harder to understand an example without having to look elsewhere to
understand its context.
</p>
<p>
That said, RSpec does support some level of encapsulating common code in
helper methods that can exist within a context or within an included
module.
</p>
<h2>Setup and Teardown</h2>
<p>
You can use before and after within a Behaviour. Both methods take an
optional scope argument so you can run the block before :each example or
before :all examples
</p>
<pre>
  describe &quot;...&quot; do
    before :all do
      ...
    end

    before :each do
      ...
    end

    it &quot;should do something&quot; do
      ...
    end

    it &quot;should do something else&quot; do
      ...
    end

    after :each do
      ...
    end

    after :all do
      ...
    end

  end
</pre>
<p>
The <tt>before :each</tt> block will run before each of the examples, once
for each example. Likewise, the <tt>after :each</tt> block will run after
each of the examples.
</p>
<p>
It is also possible to specify a <tt>before :all</tt> and <tt>after
:all</tt> block that will run only once for each behaviour, respectively
before the first <tt>before :each</tt> and after the last <tt>after
:each</tt>. The use of these is generally discouraged, because it
introduces dependencies between the examples. Still, it might prove useful
for very expensive operations if you know what you are doing.
</p>
<h2>Local helper methods</h2>
<p>
You can include local helper methods by simply expressing them within a
context:
</p>
<pre>
  describe &quot;...&quot; do

    it &quot;...&quot; do
      helper_method
    end

    def helper_method
      ...
    end

  end
</pre>
<h2>Included helper methods</h2>
<p>
You can include helper methods in multiple contexts by expressing them
within a module, and then including that module in your context:
</p>
<pre>
  module AccountExampleHelperMethods
    def helper_method
      ...
    end
  end

  describe &quot;A new account&quot; do
    include AccountExampleHelperMethods
    before do
      @account = Account.new
    end

    it &quot;should have a balance of $0&quot; do
      helper_method
      @account.balance.should eql(Money.new(0, :dollars))
    end
  end
</pre>
<h2>Shared behaviour</h2>
<p>
You can define a shared behaviour, that may be used on other behaviours
</p>
<pre>
 describe &quot;All Editions&quot;, :shared =&gt; true do
   it &quot;all editions behaviour&quot; ...
 end

 describe SmallEdition do
   it_should_behave_like &quot;All Editions&quot;

   it &quot;should do small edition stuff&quot; do
     ...
   end
 end
</pre>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000217">configure</a>&nbsp;&nbsp;
      <a href="#M000218">create_dummy_spec_file</a>&nbsp;&nbsp;
      <a href="#M000219">run_spec_via_druby</a>&nbsp;&nbsp;
      <a href="#M000220">tty?</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
        <span class="include-name"><a href="Runner/ReporterSpecHelper.html">ReporterSpecHelper</a></span>
      </div>
    </div>

    <div id="section">

    <div id="class-list">
      <h3 class="section-bar">Classes and Modules</h3>

      Module <a href="Runner/Formatter.html" class="link">Spec::Runner::Formatter</a><br />
Module <a href="Runner/ReporterSpecHelper.html" class="link">Spec::Runner::ReporterSpecHelper</a><br />
Class <a href="Runner/BacktraceTweaker.html" class="link">Spec::Runner::BacktraceTweaker</a><br />
Class <a href="Runner/BehaviourRunner.html" class="link">Spec::Runner::BehaviourRunner</a><br />
Class <a href="Runner/CommandLine.html" class="link">Spec::Runner::CommandLine</a><br />
Class <a href="Runner/DrbCommandLine.html" class="link">Spec::Runner::DrbCommandLine</a><br />
Class <a href="Runner/HeckleRunner.html" class="link">Spec::Runner::HeckleRunner</a><br />
Class <a href="Runner/Heckler.html" class="link">Spec::Runner::Heckler</a><br />
Class <a href="Runner/NoisyBacktraceTweaker.html" class="link">Spec::Runner::NoisyBacktraceTweaker</a><br />
Class <a href="Runner/OptionParser.html" class="link">Spec::Runner::OptionParser</a><br />
Class <a href="Runner/Options.html" class="link">Spec::Runner::Options</a><br />
Class <a href="Runner/QuietBacktraceTweaker.html" class="link">Spec::Runner::QuietBacktraceTweaker</a><br />
Class <a href="Runner/Reporter.html" class="link">Spec::Runner::Reporter</a><br />
Class <a href="Runner/SpecParser.html" class="link">Spec::Runner::SpecParser</a><br />

    </div>




      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000217" class="method-detail">
        <a name="M000217"></a>

        <div class="method-heading">
          <a href="Runner.src/M000217.html" target="Code" class="method-signature"
            onclick="popupCode('Runner.src/M000217.html');return false;">
          <span class="method-name">configure</span><span class="method-args">() {|configuration if @configuration.nil?| ...}</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Use this to <a href="Runner.html#M000217">configure</a> various
configurable aspects of RSpec:
</p>
<pre>
  Spec::Runner.configure do |configuration|
    # Configure RSpec here
  end
</pre>
<p>
The yielded <tt>configuration</tt> object is a <a
href="DSL/Configuration.html">Spec::DSL::Configuration</a> instance. See
its RDoc for details about what you can do with it.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000218" class="method-detail">
        <a name="M000218"></a>

        <div class="method-heading">
          <a href="Runner.src/M000218.html" target="Code" class="method-signature"
            onclick="popupCode('Runner.src/M000218.html');return false;">
          <span class="method-name">create_dummy_spec_file</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000219" class="method-detail">
        <a name="M000219"></a>

        <div class="method-heading">
          <a href="Runner.src/M000219.html" target="Code" class="method-signature"
            onclick="popupCode('Runner.src/M000219.html');return false;">
          <span class="method-name">run_spec_via_druby</span><span class="method-args">(args)</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>

      <div id="method-M000220" class="method-detail">
        <a name="M000220"></a>

        <div class="method-heading">
          <a href="Runner.src/M000220.html" target="Code" class="method-signature"
            onclick="popupCode('Runner.src/M000220.html');return false;">
          <span class="method-name">tty?</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>